Skip to main content
Version: 24.05

Updates an existing address

Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.

Request Body array required
  • bpna string required

    A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.

  • name string

    The name of the address. This is not according to official registers but according to the name the sharing member chooses.

  • states object[] required

    The list of (temporary) states of the address.

  • validFrom date-time

    The date from which the state is valid.

  • validTo date-time

    The date until the state is valid.

  • type string required

    Possible values: [ACTIVE, INACTIVE]

    One of the state types: active, inactive.

  • identifiers object[] required

    The list of identifiers of the address.

  • value string required

    The value of the identifier like "0847976000005".

  • type string required

    The type of the identifier.

  • physicalPostalAddress object required

    A physical postal address describes the physical location of an office, warehouse, gate, etc.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float required

    Longitude coordinate

  • latitude float required

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string required

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • administrativeAreaLevel2 string

    The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.

  • administrativeAreaLevel3 string

    The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string required

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • district string

    The name of the district of the physical postal address which divides the city in several smaller areas.

  • street object

    The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway

  • name string

    The name of the street.

  • houseNumber string

    The number representing the exact location of a building within the street.

  • houseNumberSupplement string
  • milestone string

    The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.

  • direction string

    The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.

  • namePrefix string

    The street related information, which is usually printed before the official street name on an address label.

  • additionalNamePrefix string

    The additional street related information, which is usually printed before the official street name on an address label.

  • nameSuffix string

    The street related information, which is usually printed after the official street name on an address label.

  • additionalNameSuffix string

    The additional street related information, which is usually printed after the official street name on an address label.

  • companyPostalCode string

    The company postal code of the physical postal address, which is sometimes required for large companies.

  • industrialZone string

    The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.

  • building string

    The alphanumeric identifier of the building addressed by the physical postal address.

  • floor string

    The number of a floor in the building addressed by the physical postal address, synonym: level.

  • door string

    The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.

  • alternativePostalAddress object

    An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float required

    Longitude coordinate

  • latitude float required

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string required

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string required

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • deliveryServiceType string required

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

    One of the alternative postal address types: P.O. box, private bag, boite postale.

  • deliveryServiceQualifier string

    The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.

  • deliveryServiceNumber string required

    The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.

  • confidenceCriteria object required
  • sharedByOwner boolean required
  • checkedByExternalDataSource boolean required
  • numberOfSharingMembers int32 required
  • lastConfidenceCheckAt date-time required
  • nextConfidenceCheckAt date-time required
  • confidenceLevel int32 required
  • requestKey string required
Responses

The successfully updated records, possible errors are returned


Schema
  • entities object[]
  • bpna string

    A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.

  • name string

    The name of the address. This is not according to official registers but according to the name the sharing member chooses.

  • states object[]

    The list of (temporary) states of the address.

  • validFrom date-time

    The date from which the state is valid.

  • validTo date-time

    The date until the state is valid.

  • type object

    Named type uniquely identified by its technical key

  • technicalKey string

    Possible values: [ACTIVE, INACTIVE]

    Unique key of this type for reference

  • name string

    Name or denotation of this type

  • identifiers object[]

    The list of identifiers of the address.

  • value string

    The value of the identifier like "0847976000005".

  • type object

    Named type uniquely identified by its technical key

  • technicalKey string

    Unique key of this type for reference

  • name string

    Name or denotation of this type

  • physicalPostalAddress object

    A physical postal address describes the physical location of an office, warehouse, gate, etc.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country object

    Named type uniquely identified by its technical key

  • technicalKey string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    Unique key of this type for reference

  • name string

    Name or denotation of this type

  • administrativeAreaLevel1 object

    Region within a country

  • countryCode string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    Country code

  • regionCode string

    Abbreviation or shorthand of the area

  • regionName string

    Describes the full name of the region within a country according to ISO 3166-214

  • administrativeAreaLevel2 string

    The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.

  • administrativeAreaLevel3 string

    The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • district string

    The name of the district of the physical postal address which divides the city in several smaller areas.

  • street object

    The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway

  • name string

    The name of the street.

  • houseNumber string

    The number representing the exact location of a building within the street.

  • houseNumberSupplement string
  • milestone string

    The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.

  • direction string

    The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.

  • namePrefix string

    The street related information, which is usually printed before the official street name on an address label.

  • additionalNamePrefix string

    The additional street related information, which is usually printed before the official street name on an address label.

  • nameSuffix string

    The street related information, which is usually printed after the official street name on an address label.

  • additionalNameSuffix string

    The additional street related information, which is usually printed after the official street name on an address label.

  • companyPostalCode string

    The company postal code of the physical postal address, which is sometimes required for large companies.

  • industrialZone string

    The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.

  • building string

    The alphanumeric identifier of the building addressed by the physical postal address.

  • floor string

    The number of a floor in the building addressed by the physical postal address, synonym: level.

  • door string

    The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.

  • alternativePostalAddress object

    An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country object

    Named type uniquely identified by its technical key

  • technicalKey string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    Unique key of this type for reference

  • name string

    Name or denotation of this type

  • administrativeAreaLevel1 object

    Region within a country

  • countryCode string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    Country code

  • regionCode string

    Abbreviation or shorthand of the area

  • regionName string

    Describes the full name of the region within a country according to ISO 3166-214

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

    One of the alternative postal address types: P.O. box, private bag, boite postale.

  • deliveryServiceQualifier string

    The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.

  • deliveryServiceNumber string

    The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.

  • bpnLegalEntity string

    The BPNL of the legal entity owning the address.

  • bpnSite string

    The BPNS of the site the address belongs to.

  • isCatenaXMemberData boolean

    Indicates whether the address is owned and thus provided by a Catena-X Member.

  • createdAt date-time

    The date when the data record has been created.

  • updatedAt date-time

    The date when the data record has been last updated.

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • addressType string

    Possible values: [LegalAndSiteMainAddress, LegalAddress, SiteMainAddress, AdditionalAddress]

    Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.

  • errors object[]
  • errorCode string

    Possible values: [AddressNotFound, RegionNotFound, IdentifierNotFound, AddressDuplicateIdentifier]

    AddressUpdateError

  • message string

    Error message that explains the error

  • entityKey string

    Key of the entity that failed from the request object: index or BPN

  • entityCount int32
  • errorCount int32
Loading...